From f76c439897e3c69b2f0374c5943baedae9ae6752 Mon Sep 17 00:00:00 2001 From: Benjamin Otte Date: Sun, 19 Jun 2011 06:11:38 +0200 Subject: [PATCH] tests: Add first shot at an accessibility dump tool The tool works like this: ./accessibility-dump [FILE ...] If no files are given, all files with the extension ".ui" in the current directory are taken. For every file "test.ui", the following steps are performed: 1) test.ui is loaded using GtkBuilder 2) The accessible for the window is loaded 3) The information of accessible is converted into a string using a syntax defined in this test file 4) The generated string is diffed with the file "test.txt" 5) If the diff is empty, the test is a success, if not, the test fails. 6) The diff is output when the test runner is run with --verbose So to add a test named "test", create a file called "test.ui", put it into this directory. Then create the expected output file "test.txt", put it into this directory too. You can create the initial version of this file by invoking "./accessibility-dump --verbose test.ui". The output will contain the expected text and can be copy/pasted into the text file. --- configure.ac | 1 + tests/Makefile.am | 2 +- tests/a11y/Makefile.am | 26 +++ tests/a11y/accessibility-dump.c | 385 ++++++++++++++++++++++++++++++++ tests/a11y/hello-world.txt | 5 + tests/a11y/hello-world.ui | 17 ++ 6 files changed, 435 insertions(+), 1 deletion(-) create mode 100644 tests/a11y/Makefile.am create mode 100644 tests/a11y/accessibility-dump.c create mode 100644 tests/a11y/hello-world.txt create mode 100644 tests/a11y/hello-world.ui diff --git a/configure.ac b/configure.ac index a58ac08f77..231363af08 100644 --- a/configure.ac +++ b/configure.ac @@ -1708,6 +1708,7 @@ demos/gtk-demo/geninclude.pl demos/pixbuf-demo/Makefile examples/Makefile tests/Makefile +tests/a11y/Makefile tests/css/Makefile tests/css/parser/Makefile tests/reftests/Makefile diff --git a/tests/Makefile.am b/tests/Makefile.am index 2a74ceb701..7bed9b251d 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -1,7 +1,7 @@ ## Makefile.am for gtk+/tests include $(top_srcdir)/Makefile.decl -SUBDIRS = css reftests +SUBDIRS = css reftests a11y INCLUDES = \ -I$(top_srcdir) \ diff --git a/tests/a11y/Makefile.am b/tests/a11y/Makefile.am new file mode 100644 index 0000000000..72143fafb3 --- /dev/null +++ b/tests/a11y/Makefile.am @@ -0,0 +1,26 @@ +include $(top_srcdir)/Makefile.decl + +TEST_PROGS += accessibility-dump + +check_PROGRAMS = $(TEST_PROGS) + +accessibility_dump_CFLAGS = \ + -I$(top_srcdir) \ + -I$(top_builddir)/gdk \ + -I$(top_srcdir)/gdk \ + -DGDK_DISABLE_DEPRECATED \ + -DGTK_DISABLE_DEPRECATED \ + $(GTK_DEBUG_FLAGS) \ + $(GTK_DEP_CFLAGS) + +accessibility_dump_LDADD = \ + $(top_builddir)/gdk/libgdk-3.la \ + $(top_builddir)/gtk/libgtk-3.la \ + $(GTK_DEP_LIBS) + +accessibility_dump_SOURCES = \ + accessibility-dump.c + +EXTRA_DIST += \ + hello-world.ui \ + hello-world.txt diff --git a/tests/a11y/accessibility-dump.c b/tests/a11y/accessibility-dump.c new file mode 100644 index 0000000000..e1e2a96fc2 --- /dev/null +++ b/tests/a11y/accessibility-dump.c @@ -0,0 +1,385 @@ +/* + * Copyright (C) 2011 Red Hat Inc. + * + * Author: + * Benjamin Otte + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public + * License along with this library; if not, write to the + * Free Software Foundation, Inc., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#include "config.h" + +#include +#include +#include + +#define DEPTH_INCREMENT 2 + +static char * +get_test_file (const char *test_file, + const char *extension, + gboolean must_exist) +{ + GString *file = g_string_new (NULL); + + if (g_str_has_suffix (test_file, ".ui")) + g_string_append_len (file, test_file, strlen (test_file) - strlen (".ui")); + else + g_string_append (file, test_file); + + g_string_append (file, extension); + + if (must_exist && + !g_file_test (file->str, G_FILE_TEST_EXISTS)) + { + g_string_free (file, TRUE); + return NULL; + } + + return g_string_free (file, FALSE); +} + +static char * +diff_with_file (const char *file1, + char *text, + gssize len, + GError **error) +{ + const char *command[] = { "diff", "-u", file1, NULL, NULL }; + char *diff, *tmpfile; + int fd; + + diff = NULL; + + if (len < 0) + len = strlen (text); + + /* write the text buffer to a temporary file */ + fd = g_file_open_tmp (NULL, &tmpfile, error); + if (fd < 0) + return NULL; + + if (write (fd, text, len) != (int) len) + { + close (fd); + g_set_error (error, + G_FILE_ERROR, G_FILE_ERROR_FAILED, + "Could not write data to temporary file '%s'", tmpfile); + goto done; + } + close (fd); + command[3] = tmpfile; + + /* run diff command */ + g_spawn_sync (NULL, + (char **) command, + NULL, + G_SPAWN_SEARCH_PATH, + NULL, NULL, + &diff, + NULL, NULL, + error); + +done: + g_unlink (tmpfile); + g_free (tmpfile); + + return diff; +} + +static const char * +get_name (AtkObject *accessible) +{ + char *name; + + name = g_object_get_data (G_OBJECT (accessible), "gtk-accessibility-dump-name"); + if (name) + return name; + + if (GTK_IS_ACCESSIBLE (accessible)) + { + GtkWidget *widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (accessible)); + + name = g_strdup (gtk_buildable_get_name (GTK_BUILDABLE (widget))); + } + else + name = NULL; + + if (name == NULL) + { + /* XXX: Generate a unique, repeatable name */ + g_assert_not_reached (); + } + + g_object_set_data_full (G_OBJECT (accessible), "gtk-accessibility-dump-name", name, g_free); + return name; +} + +static void +dump_relation (GString *string, + guint depth, + AtkRelation *relation) +{ + GPtrArray *targets; + const char *name; + guint i; + + targets = atk_relation_get_target (relation); + if (targets == NULL || targets->len == 0) + return; + + name = atk_relation_type_get_name (atk_relation_get_relation_type (relation)); + g_string_append_printf (string, "%*s%s: %s\n", depth, "", name, get_name (g_ptr_array_index (targets, 0))); + depth += strlen (name) + 2; + + for (i = 1; i < targets->len; i++) + { + g_string_append_printf (string, "%*s%s\n", depth, "", get_name (g_ptr_array_index (targets, i))); + } +} + +static void +dump_relation_set (GString *string, + guint depth, + AtkRelationSet *set) +{ + guint i; + + if (set == NULL) + return; + + for (i = 0; i < atk_relation_set_get_n_relations (set); i++) + { + AtkRelation *relation; + + relation = atk_relation_set_get_relation (set, i); + + dump_relation (string, depth, relation); + } + + g_object_unref (set); +} + +static void +dump_accessible (AtkObject *accessible, + guint depth, + GString *string) +{ + guint i; + + g_string_append_printf (string, "%*s%s\n", depth, "", get_name (accessible)); + depth += DEPTH_INCREMENT; + + g_string_append_printf (string, "%*s\"%s\"\n", depth, "", atk_role_get_name (atk_object_get_role (accessible))); + if (atk_object_get_name (accessible)) + g_string_append_printf (string, "%*sname: %s\n", depth, "", atk_object_get_name (accessible)); + if (atk_object_get_description (accessible)) + g_string_append_printf (string, "%*sdescription: %s\n", depth, "", atk_object_get_description (accessible)); + dump_relation_set (string, depth, atk_object_ref_relation_set (accessible)); + + for (i = 0; i < atk_object_get_n_accessible_children (accessible); i++) + { + AtkObject *child = atk_object_ref_accessible_child (accessible, i); + dump_accessible (child, depth, string); + g_object_unref (child); + } +} + +static GtkWidget * +builder_get_toplevel (GtkBuilder *builder) +{ + GSList *list, *walk; + GtkWidget *window = NULL; + + list = gtk_builder_get_objects (builder); + for (walk = list; walk; walk = walk->next) + { + if (GTK_IS_WINDOW (walk->data) && + gtk_widget_get_parent (walk->data) == NULL) + { + window = walk->data; + break; + } + } + + g_slist_free (list); + + return window; +} + +static void +dump_ui_file (const char *ui_file, + GString *string) +{ + GtkWidget *window; + GtkBuilder *builder; + GError *error = NULL; + + builder = gtk_builder_new (); + gtk_builder_add_from_file (builder, ui_file, &error); + g_assert_no_error (error); + window = builder_get_toplevel (builder); + g_object_unref (builder); + g_assert (window); + + gtk_widget_show (window); + + dump_accessible (gtk_widget_get_accessible (window), 0, string); + gtk_widget_destroy (window); +} + +static void +test_ui_file (GFile *file) +{ + char *diff; + char *ui_file, *a11y_file; + GString *dump; + GError *error = NULL; + + ui_file = g_file_get_path (file); + a11y_file = get_test_file (ui_file, ".txt", TRUE); + dump = g_string_new (""); + + dump_ui_file (ui_file, dump); + + if (a11y_file) + { + diff = diff_with_file (a11y_file, dump->str, dump->len, &error); + g_assert_no_error (error); + + if (diff && diff[0]) + { + g_test_message ("Contents don't match expected contents:\n%s", diff); + g_test_fail (); + } + } + else if (dump->str[0]) + { + g_test_message ("Expected a reference file:\n%s", dump->str); + g_test_fail (); + } + + g_string_free (dump, TRUE); + g_free (diff); + g_free (a11y_file); + g_free (ui_file); +} + +static void +add_test_for_file (GFile *file) +{ + g_test_add_vtable (g_file_get_path (file), + 0, + g_object_ref (file), + NULL, + (GTestFixtureFunc) test_ui_file, + (GTestFixtureFunc) g_object_unref); +} + +static int +compare_files (gconstpointer a, gconstpointer b) +{ + GFile *file1 = G_FILE (a); + GFile *file2 = G_FILE (b); + char *path1, *path2; + int result; + + path1 = g_file_get_path (file1); + path2 = g_file_get_path (file2); + + result = strcmp (path1, path2); + + g_free (path1); + g_free (path2); + + return result; +} + +static void +add_tests_for_files_in_directory (GFile *dir) +{ + GFileEnumerator *enumerator; + GFileInfo *info; + GList *files; + GError *error = NULL; + + enumerator = g_file_enumerate_children (dir, G_FILE_ATTRIBUTE_STANDARD_NAME, 0, NULL, &error); + g_assert_no_error (error); + files = NULL; + + while ((info = g_file_enumerator_next_file (enumerator, NULL, &error))) + { + const char *filename; + + filename = g_file_info_get_name (info); + + if (!g_str_has_suffix (filename, ".ui")) + { + g_object_unref (info); + continue; + } + + files = g_list_prepend (files, g_file_get_child (dir, filename)); + + g_object_unref (info); + } + + g_assert_no_error (error); + g_object_unref (enumerator); + + files = g_list_sort (files, compare_files); + g_list_foreach (files, (GFunc) add_test_for_file, NULL); + g_list_free_full (files, g_object_unref); +} + +int +main (int argc, char **argv) +{ + gtk_test_init (&argc, &argv); + + if (argc < 2) + { + const char *basedir; + GFile *dir; + + if (g_getenv ("srcdir")) + basedir = g_getenv ("srcdir"); + else + basedir = "."; + + dir = g_file_new_for_path (basedir); + + add_tests_for_files_in_directory (dir); + + g_object_unref (dir); + } + else + { + guint i; + + for (i = 1; i < argc; i++) + { + GFile *file = g_file_new_for_commandline_arg (argv[i]); + + add_test_for_file (file); + + g_object_unref (file); + } + } + + return g_test_run (); +} + diff --git a/tests/a11y/hello-world.txt b/tests/a11y/hello-world.txt new file mode 100644 index 0000000000..d6b0fbbc9a --- /dev/null +++ b/tests/a11y/hello-world.txt @@ -0,0 +1,5 @@ +window1 + "window" + button1 + "push button" + name: Hello World! diff --git a/tests/a11y/hello-world.ui b/tests/a11y/hello-world.ui new file mode 100644 index 0000000000..3dc807570f --- /dev/null +++ b/tests/a11y/hello-world.ui @@ -0,0 +1,17 @@ + + + + + False + popup + + + Hello World! + True + True + True + False + + + + -- 2.30.2